6.4 查询外部用户群组详情

基本信息

Path: /api/v1/externalUserBand/queryById

Method: GET

接口描述:

请求参数

Query

根据群组ID查询

参数名称 是否必须 示例 备注
id 必须 外部用户群组ID

根据群组名称查询

参数名称 是否必须 示例 备注
name 必须 外部用户群组名称
userDirectoryId 与userDirectoryName二选一 所属用户目录ID,ID和名称只需传一个即可,都传时以ID为准
userDirectoryName 与userDirectoryId二选一 所属用户目录名称,ID和名称只需传一个即可,都传时以ID为准
type 必须 0 群组类型,0本地自定义群组,1外部导入群组

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code string 必须 错误码
data object 必须 返回数据
├─ data object[] 必须 数据
├─├─ id string 必须 群组ID
├─├─ userDirectoryId string 必须 所属用户目录ID
├─├─ name string 必须 群组名称
├─├─ description string 必须 描述
├─├─ type number 必须 群组类型,0本地自定义群组,1外部导入群组
msg string 必须 错误消息  

返回示例

{
    "code": 0,
    "data": {
        "data": [{
            "id": "ab3ea440-5b07-11eb-a393-bbd9cb0893d1",
            "userDirectoryId": "d36ccb20-596a-11eb-a393-bbd9cb0893d1",
            "type": 1,
            "name": "外部用户群组",
            "description": "1111",
        }]
    },
    "msg": "请求成功"
}

错误信息

错误提示 错误码
参数检查出错 10000001
用户目录不存在 77200001
操作失败,对象不存在或已被其他管理员删除 77200004
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""